Include method names into headings in REST API documentation The headings for the REST endpoints contain currently only the URL path of the endpoint. Add also the method (e.g. GET) because one REST endpoint can accept different methods which provide different functionalities. The different functionalities should be described in own sections which is why it should be clear from the headings to which method a section relates. Change-Id: I4469d1448a62f48687945ba533e9f8002b9adff6 Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt index 5d164b2..27f579d 100644 --- a/Documentation/rest-api-changes.txt +++ b/Documentation/rest-api-changes.txt
@@ -8,8 +8,8 @@ Endpoints --------- -/changes/ (Query Changes) -~~~~~~~~~~~~~~~~~~~~~~~~~ +GET /changes/ (Query Changes) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Queries changes visible to the caller. The query string must be provided by the `q` parameter. The `n` parameter can be used to limit the returned results.
